Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
NtpPTProcess Class Reference
Inheritance diagram for NtpPTProcess:
Process

Public Member Functions

void setEnabled (bool)
 Enables or disables the NTP server. More...
 
bool isEnabled ()
 Returns true if the NTP server is enabled, otherwise false. More...
 
void setKeyID (int)
 Sets the NTP authentication key to the specified value. More...
 
int getKeyId ()
 Returns the NTP authentication key. More...
 
string getServerMd5Str ()
 Returns the NTP authentication password. More...
 
void setServerMd5Str (string)
 Sets the NTP authentication password. More...
 
bool getNtpServerAuthentication ()
 Get if the server is set to authenticate. More...
 
void setNtpServerAuthentication (bool)
 Set if the server is supposed to authenticate. More...
 
void setRefClockTime (string)
 Set the ref clock time. More...
 
string getRefClockTime ()
 Gets the ref clock time. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Member Function Documentation

◆ getKeyId()

int NtpPTProcess::getKeyId ( )

Returns the NTP authentication key.

Returns
long, the value of the NTP authentication key.

◆ getNtpServerAuthentication()

bool NtpPTProcess::getNtpServerAuthentication ( )

Get if the server is set to authenticate.

Returns
bool, true if it is set to authenticate, false if not.

◆ getRefClockTime()

string NtpPTProcess::getRefClockTime ( )

Gets the ref clock time.

Returns
string, ref clock time. Example time: "Tue May 24 2016 10:21:27.929 UTC".

◆ getServerMd5Str()

string NtpPTProcess::getServerMd5Str ( )

Returns the NTP authentication password.

Returns
string, the NTP authentication password.

◆ isEnabled()

bool NtpPTProcess::isEnabled ( )

Returns true if the NTP server is enabled, otherwise false.

Returns
bool, true if the NTP server is enabled, otherwise false.

◆ setEnabled()

void NtpPTProcess::setEnabled ( bool  )

Enables or disables the NTP server.

Parameters
enable,trueto enable the NTP server, false to disable it.

◆ setKeyID()

void NtpPTProcess::setKeyID ( int  )

Sets the NTP authentication key to the specified value.

Parameters
key,theNTP authentication key value.

◆ setNtpServerAuthentication()

void NtpPTProcess::setNtpServerAuthentication ( bool  )

Set if the server is supposed to authenticate.

Parameters
yes,trueif it should be set to authenticate, false if not.

◆ setRefClockTime()

void NtpPTProcess::setRefClockTime ( string  )

Set the ref clock time.

Parameters
time,timeto set the clock to. Example time: "Tue May 24 2016 10:21:27.929 UTC".

◆ setServerMd5Str()

void NtpPTProcess::setServerMd5Str ( string  )

Sets the NTP authentication password.

Parameters
md5,theNTP authentication password.

The documentation for this class was generated from the following file: